Recommended
More Related Content
Similar to Advanced API Design: how an awesome API can attract friends, make you rich, and change the world
Similar to Advanced API Design: how an awesome API can attract friends, make you rich, and change the world (14)
More from Jonathan Dahl
More from Jonathan Dahl (9)
Recently uploaded
Recently uploaded (20)
Advanced API Design: how an awesome API can attract friends, make you rich, and change the world
- 1. Advanced API Design How an awesome API can attract friends, make you rich, and change the world Jon Dahl @jondahl jon@zencoder.com Monday, May 23, 2011
- 2. Application Programming Interface Monday, May 23, 2011
- 3. User Interface Monday, May 23, 2011
- 4. Interface Monday, May 23, 2011
- 5. Library SDK Monday, May 23, 2011
- 6. Net::SSH Monday, May 23, 2011
- 7. Web Service Monday, May 23, 2011
- 8. Simple Object Access Protocol Monday, May 23, 2011
- 9. Simple Object Access Protocol Monday, May 23, 2011
- 10. REST Monday, May 23, 2011
- 11. HTTP Monday, May 23, 2011
- 12. Web is an API Monday, May 23, 2011
- 13. GET /records Monday, May 23, 2011
- 14. POST /record/new Monday, May 23, 2011
- 15. POST /record/new <xml> <data>Foo</data> </xml> Monday, May 23, 2011
- 16. POST /record/new { "data" : "foo" } Monday, May 23, 2011
- 17. Monday, May 23, 2011
- 18. (Don’t tell our investors that we don’t have a real product) Monday, May 23, 2011
- 19. Monday, May 23, 2011
- 20. Monday, May 23, 2011
- 21. 1. Secondary Flickr Twitter Linkedin Facebook Monday, May 23, 2011
- 22. 2. Infrastructure Amazon Web Services EC2 S3 SQS RDS SNS SES Monday, May 23, 2011
- 23. 3. Technology Twilio SimpleGeo Sendgrid Zencoder Factual Spreedly Recurly Saplo Tropo CloudMailin UploadJuicer Monday, May 23, 2011
- 24. 4. Science Fiction PiCloud Crowdflower Amazon Mechanical Turk Monday, May 23, 2011
- 25. Monday, May 23, 2011
- 26. Monday, May 23, 2011
- 27. Monday, May 23, 2011
- 28. so, how do you design a good API? Monday, May 23, 2011
- 29. Version it Monday, May 23, 2011
- 30. GET /api/records/38927 { "color" : "green", "velocity" : 1000000 } Monday, May 23, 2011
- 31. GET /api/records/38927 { "color" : "10EE33", "velocity" : 1000000 } Monday, May 23, 2011
- 32. GET /api/v1/records/38927 { "color" : "green", "velocity" : 1000000 } Monday, May 23, 2011
- 33. GET /api/v2/records/38927 { "color" : "10EE33", "velocity" : 1000000 } Monday, May 23, 2011
- 34. REST conventions Monday, May 23, 2011
- 35. GET records POST jobs PUT messages DELETE servers users Monday, May 23, 2011
- 36. HTTP codes Monday, May 23, 2011
- 37. 200 OK 201 Created 202 Accepted 400 Bad Request 401 Unauthorized 402 Payment Required 404 Not Found 409 Conflict 418 I’m a teapot 422 Unprocessable Entity 500 Internal Server Error 503 Service Unavailable Monday, May 23, 2011
- 38. ... and many more! Monday, May 23, 2011
- 39. Smart validations Monday, May 23, 2011
- 40. POST /api/jobs HTTP/1.1 Accept: application/json Content-Type: application/json { "api_key" : "Not A Real Key" } Monday, May 23, 2011
- 41. HTTP/1.1 500 Internal Server Error Monday, May 23, 2011
- 42. HTTP/1.1 401 Unauthorized Monday, May 23, 2011
- 43. HTTP/1.1 401 Unauthorized { "errors": [ "api_key not found" ] } Monday, May 23, 2011
- 44. HTTP/1.1 401 Unauthorized { "errors": [ "api_key not found.", "api_key may not include spaces." ] } Monday, May 23, 2011
- 45. HTTP/1.1 401 Unauthorized { "errors": [ "api_key not found. Please log in to https:// example.com/account/api to retrieve your API key.", "api_key may not include spaces." ] } Monday, May 23, 2011
- 46. POST /api/user HTTP/1.1 Accept: application/json Content-Type: application/json { "api_key" : "A23B92F281CC" "strength" : 18 } Monday, May 23, 2011
- 47. HTTP/1.1 400 Bad Request Monday, May 23, 2011
- 48. HTTP/1.1 400 Bad Request { "errors": [ "JSON is not valid. Syntax error, unexpected TSTRING, expecting '}' at line 2" ] } Monday, May 23, 2011
- 49. JSON + XML Monday, May 23, 2011
- 50. Monday, May 23, 2011
- 51. Monday, May 23, 2011
- 52. POST /api/user HTTP/1.1 Accept: application/json Content-Type: application/json { "api_key" : "A23B92F281CC" "strength" : 18 } Monday, May 23, 2011
- 53. params[:strength] # 18 Monday, May 23, 2011
- 54. respond_to do |wants| wants.json { render :json => @jobs.to_json } wants.xml { render :xml => @jobs.to_xml } end Monday, May 23, 2011
- 55. Document it Monday, May 23, 2011
- 56. Zencoder::API.define_setting :audio_channels, :section => section do |z| z.tip = "The number of audio channels: 1 or 2." z.description = %Q{ <p>The number of audio channels to use: 1 (mono) or 2 (stereo).</p> <p>Note that mono AAC audio sometimes erroneously self-reports as stereo when inspected. We recommend using iTunes to get the true number of channels for AAC audio.</p> } z.data_type = "Integer" z.valid = "1 or 2" z.default = "1 if the original file is mono; otherwise, 2." z.example = "1" z.see_also = [:audio_bitrate, :audio_quality] end Monday, May 23, 2011
- 57. Monday, May 23, 2011
- 58. Libraries Monday, May 23, 2011
- 59. Support it Monday, May 23, 2011
- 60. APIs are scary. Monday, May 23, 2011
- 61. Make it fast Monday, May 23, 2011
- 62. Rate limiting Monday, May 23, 2011
- 63. Log requests Monday, May 23, 2011
- 64. Monday, May 23, 2011
- 65. Monday, May 23, 2011
- 66. Request builder Monday, May 23, 2011
- 67. Monday, May 23, 2011
- 68. Monday, May 23, 2011
- 69. GET /api/ideas Monday, May 23, 2011
- 70. 1. Make friends Monday, May 23, 2011
- 71. Monday, May 23, 2011
- 72. Awesomeness is noticed Monday, May 23, 2011
- 73. (Assymetrical reward curve) Monday, May 23, 2011
- 74. value quality Monday, May 23, 2011
- 75. value quality Monday, May 23, 2011
- 76. value quality Monday, May 23, 2011
- 77. Bus Driving value quality Monday, May 23, 2011
- 78. Bus Driving value quality Monday, May 23, 2011
- 79. Monday, May 23, 2011
- 80. Sports value quality Monday, May 23, 2011
- 81. API design value quality Monday, May 23, 2011
- 82. "I know the following statement is going to sound dramatic, but it's the truth. Zencoder seriously uplifted my entire day. The API is really well designed and has documentation for not only what each value should be but also what an example input/output would look like using the value. I had spent the earlier part of the day working with a web service that is the complete opposite of those things. So when I started digging into Zencoder I felt like I was witnessing a double rainbow. Then when I found the API Builder, it went beyond a double rainbow to a level I can only imagine is equal to witnessing a unicorn birth.” Monday, May 23, 2011
- 83. 2. Get rich Monday, May 23, 2011
- 84. Cloud computing revenue forecast $150B $148.8B $100B $68.3B $50B $0B 2010 2014 Source: Gartner 2010 Monday, May 23, 2011
- 85. 4. Twilio SimpleGeo Sendgrid Zencoder Factual Spreedly Recurly Saplo Tropo CloudMailin UploadJuicer Monday, May 23, 2011
- 86. API to Monday, May 23, 2011
- 87. API to Ruby Monday, May 23, 2011
- 88. API to the government Monday, May 23, 2011
- 89. API to manufacturing Monday, May 23, 2011
- 90. 3. Change the world Monday, May 23, 2011
- 91. Monday, May 23, 2011
- 92. Monday, May 23, 2011
- 93. Monday, May 23, 2011
- 94. Monday, May 23, 2011
- 95. Monday, May 23, 2011
- 96. Monday, May 23, 2011
- 97. Monday, May 23, 2011
- 98. Monday, May 23, 2011
- 99. Monday, May 23, 2011
- 100. Monday, May 23, 2011
- 101. Monday, May 23, 2011
- 102. POST /api/awesome_things HTTP/1.1 { "team_size" : 3, "productivity" : "10x" } Monday, May 23, 2011
- 103. Thanks! Jon Dahl @jondahl jon@zencoder.com Monday, May 23, 2011